Migrate tests for model serialization to goldens. #244
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mihaimaruseac
added a commit
to mihaimaruseac/model-transparency
that referenced
this pull request
Jul 22, 2024
Similar to sigstore#241, there is a duplication in the directory traversal between serializing to a digest and serializing to a manifest. This time, both supported parallelism, so there is really no need for the duplication. We make an abstract `ShardedFilesSerializer` class to contain the logic for the directory traversal and then create the better named `DigestSerializer` and `ManifestSerializer` for the two serializing classes. This time, instead of trying extremely hard to match the old behavior for digest serialization, we just update the goldens. This means that this depends on sigstore#244. We still had to update some other tests: since the hashes are computed only for files, we no longer differentiate between a model with an empty directory and a model where that empty directory is completely removed. This is a corner case and it is ok to do this. In fact, ignoring empty directories is part of the optimization hinted at in sigstore#197. Signed-off-by: Mihai Maruseac <mihaimaruseac@google.com>
mihaimaruseac
force-pushed
the
use-golden-tests
branch
4 times, most recently
from
1da2824
to
b13682a
Compare
This is to ensure that whenever we change the model serialization code, it is much easier to update the tests. The changes should be more readable this way. When code changes to request changes to the goldens, the author of the change will need to run a `pytest` command to update the files by passing a flag, then add the goldens to the PR (ideally via a new commit). This also ensures that we can test all models in all scenarios, in a similar way. Thus, removed the tests for empty models that were just testing for empty manifest. Added a new model that only contains an empty file. Signed-off-by: Mihai Maruseac <mihaimaruseac@google.com>
mihaimaruseac
force-pushed
the
use-golden-tests
branch
from
b13682a
to
9e7b76a
Compare
spencerschrock
approved these changes
Jul 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This is to ensure that whenever we change the model serialization code, it is much easier to update the tests. The changes should be more readable this way.
When code changes to request changes to the goldens, the author of the change will need to run a
pytestcommand to update the files by passing a flag, then add the goldens to the PR (ideally via a new commit).This also ensures that we can test all models in all scenarios, in a similar way. Thus, removed the tests for empty models that were just testing for empty manifest. Added a new model that only contains an empty file.
Release Note
NONE
Documentation
NONE